Improved extension README #2352
Conversation
extensions/vscode/README.md
Outdated
| Install Posit Publisher by using the Install button above, or using the | ||
| Extensions side bar in [Positron](https://github.com/posit-dev/positron) or | ||
| [VS Code](https://code.visualstudio.com/) and searching for `posit.publisher`. |
There was a problem hiding this comment.
Trying to be more generic about the install instructions here to account for users seeing this in Positron or VS Code.
extensions/vscode/README.md
Outdated
| way to deploy to [Posit Connect](https://posit.co/products/enterprise/connect/). | ||
| [Posit Publisher](https://github.com/posit-dev/publisher) is a code-first tool | ||
| for deploying to | ||
| [Posit Connect](https://posit.co/products/enterprise/connect/). |
There was a problem hiding this comment.
Suggest including the types of things supported?
Posit Publisher is a code-first tool with a push-button user interface for deploying the things you build in R and Python to Posit Connect.
Supported content types (frameworks) (From the changelog?)
- Python content: APIs, applications, and notebooks
- Quarto content: .qmd and .Rmd files. Support for embedded Shiny apps
- R content: Shiny apps, RMarkdown, Plumber APIs, and Rmd with embedded Shiny apps
There was a problem hiding this comment.
I was a bit worried about listing everything since it would be quite long - see the types we support from the Configuration doc.
But it did feel strange to leave it out. Thanks for the suggestion, I'll get something added!
There was a problem hiding this comment.
I included this verbatim. I tried to come up with a more succinct opener but its nice to include "code-first" and "push-button" into the first line. Let me know if you agree that it is a little cumbersome, and we can try to reduce it.
extensions/vscode/README.md
Outdated
|
|
||
| ### Track all Deployments for a Project | ||
|
|
||
| Separate staging and production deployments easily per project. |
There was a problem hiding this comment.
Add another line above, and clarified that this was an example.
|
I'm a little worried about the use of "project" being misunderstood as the ability to deploy "a whole bunch of content" |
dotNomad
force-pushed
the
dotnomad/improved-readme
branch
from
2a715e3 to
6360a34
Compare
I'll take a pass through it and see if we can replace some instances with "content" where the name collides too much (as we discussed) |
dotNomad
force-pushed
the
dotnomad/improved-readme
branch
2 times, most recently
from
4e910de to
ebbccdb
Compare
I re-worded a few lines to avoid using "content" and "project" in the same sections. "Content" is now used more frequently, and the only place "Project" is used is when talking about "all deployments". I think this is a more understandable usage, but let me know if your concern is addressed 👍 |
dotNomad
force-pushed
the
dotnomad/improved-readme
branch
from
9d19877 to
68011ac
Compare
extensions/vscode/README.md
Outdated
| ### Seamless collaboration | ||
|
|
||
| Allow Collaborators to easily pick up where you left off by committing the | ||
| `.posit/` directory to your version control system. Your team can deploy using | ||
| the same deployments and configurations. |
There was a problem hiding this comment.
IMHO, we might hold this for when we have a more dedicated story around this. I think the code / features are almost all there, but I'm not sure folks will read this and immediately get the process we are imagining here. It would be nice to have a how to or walkthrough describing that that we could link to.
There was a problem hiding this comment.
If I'm understanding the suggestion - this sounds like removing the "Seamless collaboration" feature section in this PR. Then adding it in the future when we have those code / features and a document to walk users through the collaboration flow?
There was a problem hiding this comment.
Yeah, that's what I was thinking. It's not a "you should absolutely do that" but I was thinking about it and what I would as a user take away from this and I'm not sure there's enough detail here (or elsewhere) that really shows off what this allows (and writing that how to will take a second, probably not before 4.2)
There was a problem hiding this comment.
I removed the section, and added a follow-up task to document our collaboration flow. As a part of that we can add it back to the feature list in this README
dotNomad
force-pushed
the
dotnomad/improved-readme
branch
from
42cb59b to
497225b
Compare
dotNomad
force-pushed
the
dotnomad/improved-readme
branch
from
497225b to
c47f255
Compare
dotNomad
requested review from
kgartland-rstudio,
sagerb and
marcosnav
as code owners
dotNomad
changed the title
|
Marking this as ready to review, I'll be adding a follow-up PR with the images so those can be reviewed separately. |
Add gifs to feature sections in extension README
This PR improves the README included in the extension bundle and what is seen on the VS Code marketplace, Open VSX Registry, and when looking at the extension in Positron or VS Code.
It includes an outline of the features provided and links to our documentation and issue board.
Intent
Resolves #2024
Type of Change